Spread Windows Forms 6.0 Product Documentation
AddSparkline(SheetCellRange[],CellRange[],SparklineType,ExcelSparklineSetting) Method
See Also  Example Support Options
FarPoint.Win.Spread Assembly > FarPoint.Win.Spread Namespace > SheetView Class > AddSparkline Method : AddSparkline(SheetCellRange[],CellRange[],SparklineType,ExcelSparklineSetting) Method


data
The data.
location
The location.
type
The type.
setting
The setting.

Glossary Item Box

Adds the sparkline.

Syntax

Visual Basic (Declaration) 
Public Overloads Function AddSparkline( _
   ByVal data() As SheetCellRange, _
   ByVal location() As CellRange, _
   ByVal type As SparklineType, _
   ByVal setting As ExcelSparklineSetting _
) As ExcelSparklineGroup
Visual Basic (Usage)Copy Code
Dim instance As SheetView
Dim data() As SheetCellRange
Dim location() As CellRange
Dim type As SparklineType
Dim setting As ExcelSparklineSetting
Dim value As ExcelSparklineGroup
 
value = instance.AddSparkline(data, location, type, setting)
C# 
public ExcelSparklineGroup AddSparkline( 
   SheetCellRange[] data,
   CellRange[] location,
   SparklineType type,
   ExcelSparklineSetting setting
)

Parameters

data
The data.
location
The location.
type
The type.
setting
The setting.

Remarks

The data for the sparkline is limited to one column or row of values.

Example

This example creates a sparkline in a cell.
C#Copy Code
FarPoint.Win.Spread.SheetView sv = new FarPoint.Win.Spread.SheetView();
FarPoint.Win.Spread.Chart.SheetCellRange[] test = new FarPoint.Win.Spread.Chart.SheetCellRange[2];
test[0] = new FarPoint.Win.Spread.Chart.SheetCellRange(sv, 0, 0, 1, 5);
FarPoint.Win.Spread.Chart.SheetCellRange[] data2 = new FarPoint.Win.Spread.Chart.SheetCellRange[2];
data2[0] = new FarPoint.Win.Spread.Chart.SheetCellRange(sv, 5, 0, 1, 1);

FarPoint.Win.Spread.ExcelSparklineSetting ex = new FarPoint.Win.Spread.ExcelSparklineSetting();
fpSpread1.Sheets[0] = sv;
sv.Cells[0, 0].Value = 2;
sv.Cells[0, 1].Value = 5;
sv.Cells[0, 2].Value = 4;
sv.Cells[0, 3].Value = -1;
sv.Cells[0, 4].Value = 3;

fpSpread1.Sheets[0].AddSparkline(test[0], data2[0], FarPoint.Win.Spread.SparklineType.Column, ex);
Visual BasicCopy Code
Dim sv As New FarPoint.Win.Spread.SheetView()
Dim test(1) As FarPoint.Win.Spread.Chart.SheetCellRange
test(0) = New FarPoint.Win.Spread.Chart.SheetCellRange(sv, 0, 0, 1, 5)
Dim data2(1) As FarPoint.Win.Spread.Chart.SheetCellRange
data2(0) = New FarPoint.Win.Spread.Chart.SheetCellRange(sv, 5, 0, 1, 1)

Dim ex As New FarPoint.Win.Spread.ExcelSparklineSetting()
FpSpread1.Sheets(0) = sv
sv.Cells(0, 0).Value = 2
sv.Cells(0, 1).Value = 5
sv.Cells(0, 2).Value = 4
sv.Cells(0, 3).Value = -1
sv.Cells(0, 4).Value = 3

FpSpread1.Sheets(0).AddSparkline(test(0), data2(0), FarPoint.Win.Spread.SparklineType.Column, ex)

Requirements

Target Platforms: Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

See Also

© 2002-2012 ComponentOne, a division of GrapeCity. All Rights Reserved.